home *** CD-ROM | disk | FTP | other *** search
/ Kompuutteri Kaikille K-CD 2001 #1 / K-CD 1-2001.ISO / Tools / treepad / fileformat.txt < prev    next >
Text File  |  1999-03-01  |  2KB  |  85 lines
  1. July 06, 1998
  2.  
  3. Technical documentation on the structure of the TreePad file format.
  4.  
  5. This document describes the treePad file format 0.9 for TreePad versions 2.6 and earlier. Future file formats might be incompatible, but ther will always be an option to import older file formats.
  6.  
  7. The basic file format is text/ascii.
  8. Inside the ascii file, the start of a TreePad file should be the line:
  9. <hj-Treepad version 0.9>
  10.  
  11. every node looks like:
  12.  
  13.   <node>
  14.   the first line is the node title
  15.   the second line is a level indicator, 0 meaning at tree level 0, 1 
  16.   meaning one level up, etc.
  17.   the following lines are the article text, until you encounter:
  18.   <end node> 5P9i0s8y19Z
  19.  
  20. example for one node:
  21.  
  22.   <node>
  23.   mail from the President
  24.   4
  25.   Dear sir,
  26.  
  27.   I would like to invite you into the Oval Office
  28.   to help me run the country.
  29.   Sincerely,
  30.  
  31.   B. Clinton,
  32.   the White House
  33.   Washington
  34.   <end node> 5P9i0s8y19Z
  35.   
  36.  
  37. The indicator 5P9i0s8y19Z is simply to make sure that when someone types
  38. <end node> in the article, the program will not get confused into thinking
  39. the node has ended there (in the middle of the article). 
  40. The chance that someone types <end node> 5P9i0s8y19Z into the article area
  41. is very much smaller. Not a very beautiful implementation, but it's effective.
  42.  
  43. The order in which the nodes are listed in the TreePad file is determined
  44. by the order in which they would appear in a fully expanded tree,
  45. beginning at the top, and ending at the bottom.
  46.  
  47. E.g. a sequence of levels
  48. (the numbers are indicating the node levels):
  49.  
  50. 1 - 2 - 3 - 3 - 3 - 2
  51.  
  52. will be corresponding to the tree structure
  53. (the numbers are indicating the node levels):
  54.  
  55. 1 ___2
  56. |    |___3
  57. |    |___3
  58. |    |___3
  59. |
  60. |____2
  61.  
  62.  
  63. Warning: if you store this text in TreePad, do not include any 
  64. "<end node> 5P9i0s8y19Z" as appearing in this text !!!!!
  65.  
  66.  
  67. Future TreePad file formats
  68.  
  69. Since the current 0.9 file format does not support node marking, 
  70. node timestamps, encryption, etc., a different file format will 
  71. become necessary. This file format will also be fully public.
  72. TreePad will always support importing of older TreePad file
  73. formats.
  74.  
  75.  
  76. Henk Hagedoorn
  77. Freebyte Software Engineering
  78. Amsterdam,
  79. the Netherlands
  80. http://www.freebyte.com
  81. software@freebyte.com
  82. hjh@usa.net
  83.  
  84.  
  85.